<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxlsxwriter: Working with Cell Comments</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libxlsxwriter
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Working with Cell Comments </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Cell comments are a way of adding notation to cells in Excel. For example:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;xlsxwriter.h&quot;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main() {</div>
<div class="line"> </div>
<div class="line">    <a class="code" href="structlxw__workbook.html">lxw_workbook</a>  *workbook  = <a class="code" href="workbook_8h.html#a1cf96608a23ee4eb0e8467c15240d00b">workbook_new</a>(<span class="stringliteral">&quot;comments1.xlsx&quot;</span>);</div>
<div class="line">    <a class="code" href="structlxw__worksheet.html">lxw_worksheet</a> *worksheet = <a class="code" href="workbook_8h.html#a81d456b4f65a464e78e4a0030ecc3c2e">workbook_add_worksheet</a>(workbook, NULL);</div>
<div class="line"> </div>
<div class="line">    <a class="code" href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a>( worksheet, 0, 0, <span class="stringliteral">&quot;Hello&quot;</span> , NULL);</div>
<div class="line"> </div>
<div class="line">    <a class="code" href="worksheet_8h.html#abd1728d105365c0113e15f40c6bb1b27">worksheet_write_comment</a>(worksheet, 0, 0, <span class="stringliteral">&quot;This is a comment&quot;</span>);</div>
<div class="line"> </div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="workbook_8h.html#ad9e7aeebc0fd43562db5bcd527b2ee5e">workbook_close</a>(workbook);</div>
<div class="line">}</div>
</div><!-- fragment --><div class="image">
<img src="comments1.png" alt=""/>
</div>
<h1><a class="anchor" id="ww_comments_properties"></a>
Setting Comment Properties</h1>
<p>The properties of the cell comment can be modified by passing an optional <a class="el" href="structlxw__comment__options.html" title="Options for inserted comments.">lxw_comment_options</a> struct to <code><a class="el" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7" title="Write a comment to a worksheet cell with options.">worksheet_write_comment_opt()</a></code> control the format of the comment. For example:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__image__options.html#ac75127b545dc66c6a24e3b41bd20a7ab">x_scale</a> = 1.2, .y_scale = 0.5};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>The following options are available in <a class="el" href="structlxw__comment__options.html" title="Options for inserted comments.">lxw_comment_options</a>:</p>
<ul>
<li><code>author</code></li>
<li><code>visible</code></li>
<li><code>width</code></li>
<li><code>height</code></li>
<li><code>x_scale</code></li>
<li><code>y_scale</code></li>
<li><code>color</code></li>
<li><code>font_name</code></li>
<li><code>font_size</code></li>
<li><code>start_row</code></li>
<li><code>start_col</code></li>
<li><code>x_offset</code></li>
<li><code>y_offset</code></li>
</ul>
<p>The options are explained in detail below and shown in <a class="el" href="comments2_8c-example.html">comments2.c</a>.</p>
<h2><a class="anchor" id="ww_comments_author"></a>
Cell comments: author</h2>
<p>This <code>author</code> option is used to indicate who is the author of the cell comment. Excel displays the author of the comment in the status bar at the bottom of the worksheet. This is usually of interest in corporate environments where several people might review and provide comments to a workbook:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#ac5b73a7c784616e582aba3f3f7ae56d9">author</a> = <span class="stringliteral">&quot;Ian McEwan&quot;</span>};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Atonement&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>The default author for all cell comments in a worksheet can be set using the <code><a class="el" href="worksheet_8h.html#af196b0cb611f3abc800f3439f3bb8942" title="Set the default author of the cell comments.">worksheet_set_comments_author()</a></code> function:</p>
<div class="fragment"><div class="line"><a class="code" href="worksheet_8h.html#af196b0cb611f3abc800f3439f3bb8942">worksheet_set_comments_author</a>(worksheet, <span class="stringliteral">&quot;Jane Gloriana Villanueva&quot;</span>)</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_visible"></a>
Cell comments: visible</h2>
<p>The <code>visible</code> option is used to make a cell comment visible when the worksheet is opened. The default behavior in Excel is that comments are initially hidden. However, it is also possible in Excel to make individual comments or all comments visible. In libxlsxwriter individual comments can be made visible as follows:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a3a3399ada29d05d2e7702e881fbe3ccb">visible</a> = <a class="code" href="worksheet_8h.html#aad352c6cf9a5359d4cda51839a91c7d2a3d78b49cb38d25b6d5473a1c0112404d">LXW_COMMENT_DISPLAY_VISIBLE</a>};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello.&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>The <code>visible</code> property should be set with one of the enum values from <a class="el" href="worksheet_8h.html#aad352c6cf9a5359d4cda51839a91c7d2">lxw_comment_display_types</a>.</p>
<p>It is possible to make all comments in a worksheet visible using the <code><a class="el" href="worksheet_8h.html#aafb945c6f7f462e7c6eb24032ea4e61a" title="Make all comments in the worksheet visible.">worksheet_show_comments()</a></code> worksheet function. Alternatively, if all of the cell comments have been made visible you can hide individual comments:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a3a3399ada29d05d2e7702e881fbe3ccb">visible</a> = <a class="code" href="worksheet_8h.html#aad352c6cf9a5359d4cda51839a91c7d2a3d229e4bc94662b4ed744abd40182728">LXW_COMMENT_DISPLAY_HIDDEN</a>};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_width"></a>
Cell comments: width</h2>
<p>The <code>width</code> option is used to set the width of the cell comment box explicitly in pixels:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#abc75ab267fe81d828844e6a619c7edef">width</a> = 200};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>The width and height can be adjusted together:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#abc75ab267fe81d828844e6a619c7edef">width</a> = 200, .height = 50};</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_height"></a>
Cell comments: height</h2>
<p>The <code>height</code> option is used to set the height of the cell comment box explicitly in pixels:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#ab536125829ddfea261406141685cd868">height</a> = 50};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>The width and height can be adjusted together:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#abc75ab267fe81d828844e6a619c7edef">width</a> = 200, .height = 50};</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_x_scale"></a>
Cell comments: x_scale</h2>
<p>The <code>x_scale</code> option is used to set the width of the cell comment box as a factor of the default width:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a6fe2a539fa5448c499fbbbef3215976c">x_scale</a> = 2.0};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_y_scale"></a>
Cell comments: y_scale</h2>
<p>The <code>y_scale</code> option is used to set the height of the cell comment box as a factor of the default height:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#aa5cdcb6a45356c37c44c9601117e64a0">y_scale</a> = 2.0};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_color"></a>
Cell comments: color</h2>
<p>The <code>color</code> option is used to set the background color of cell comment box. The color should be an RGB integer value, see <a class="el" href="working_with_colors.html">Working with Colors</a>.</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options1 = {.color = <a class="code" href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871">LXW_COLOR_GREEN</a>};</div>
<div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options2 = {.color = 0xFF6600};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options1);</div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C7&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options2);</div>
</div><!-- fragment --><h2><a class="anchor" id="ww_comments_font_name"></a>
Cell comments: font_name</h2>
<p>The <code>font_name</code> option is used to set the font for the comment:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a81608aa6e7816544847c1a74beb0f34d">font_name</a> = <span class="stringliteral">&quot;Courier&quot;</span>};</div>
</div><!-- fragment --><p>The default font is 'Tahoma'.</p>
<h2><a class="anchor" id="ww_comments_font_size"></a>
Cell comments: font_size</h2>
<p>The <code>font_size</code> option is used to set the font size for the comment:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a81608aa6e7816544847c1a74beb0f34d">font_name</a> = <span class="stringliteral">&quot;Courier&quot;</span>, .font_size = 10};</div>
</div><!-- fragment --><p>The default font size is 8.</p>
<h2><a class="anchor" id="ww_comments_start_row"></a>
Cell comments: start_row</h2>
<p>The <code>start_row</code> option is used to set the row in which the comment will appear. By default Excel displays comments one cell to the right and one cell above the cell to which the comment relates. The row is zero indexed:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a1360f4a255e8c255b3759d44205de938">start_row</a> = 3, .start_col = 4};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>See <a class="el" href="working_with_comments.html#ww_comments_notes">Notes on scaling of cell comments</a></p>
<h2><a class="anchor" id="ww_comments_start_col"></a>
Cell comments: start_col</h2>
<p>The <code>start_col</code> option is used to set the column in which the comment will appear. By default Excel displays comments one cell to the right and one cell above the cell to which the comment relates. The column is zero indexed:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a1360f4a255e8c255b3759d44205de938">start_row</a> = 3, .start_col = 4};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>See <a class="el" href="working_with_comments.html#ww_comments_notes">Notes on scaling of cell comments</a></p>
<h2><a class="anchor" id="ww_comments_x_offset"></a>
Cell comments: x_offset</h2>
<p>The <code>x_offset</code> option is used to change the x offset, in pixels, of a comment within a cell:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a85ea5b7a9deceb6b5dd9b1580b49b5a5">x_offset</a> = 30, .y_offset = 12};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>See <a class="el" href="working_with_comments.html#ww_comments_notes">Notes on scaling of cell comments</a></p>
<h2><a class="anchor" id="ww_comments_y_offset"></a>
Cell comments: y_offset</h2>
<p>The <code>y_offset</code> option is used to change the y offset, in pixels, of a comment within a cell:</p>
<div class="fragment"><div class="line"><a class="code" href="structlxw__comment__options.html">lxw_comment_options</a> options = {.<a class="code" href="structlxw__comment__options.html#a85ea5b7a9deceb6b5dd9b1580b49b5a5">x_offset</a> = 30, .y_offset = 12};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a>(worksheet, <a class="code" href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a>(<span class="stringliteral">&quot;C6&quot;</span>), <span class="stringliteral">&quot;Hello&quot;</span>, &amp;options);</div>
</div><!-- fragment --><p>See <a class="el" href="working_with_comments.html#ww_comments_notes">Notes on scaling of cell comments</a></p>
<h2><a class="anchor" id="ww_comments_notes"></a>
Notes on scaling of cell comments</h2>
<p><b>Note on options that move a cell position:</b></p>
<p>Excel only displays offset cell comments when they are displayed as <code>visible</code>. Excel does <b>not</b> display hidden cells as displaced when you mouse over them. Please note this when using options that adjust the position of the cell comment such as <code>start_row</code>, <code>start_col</code>, <code>x_offset</code> and <code>y_offset</code>.</p>
<p><b>Note on row height and comments:</b></p>
<p>If you specify the height of a row that contains a comment then libxlsxwriter will adjust the height of the comment to maintain the default or user specified dimensions. However, the height of a row can also be adjusted automatically by Excel if the text wrap property is set or large fonts are used in the cell. This means that the height of the row is unknown to the library at run time and thus the comment box is stretched with the row. Use the <code><a class="el" href="worksheet_8h.html#ab9b7fb95e1bd9b0da70befd0d37a9173" title="Set the properties for a row of cells.">worksheet_set_row()</a></code> function to specify the row height explicitly and avoid this problem. See Example 8 of <a class="el" href="comments2_8c-example.html">comments2.c</a>.</p>
<p>Next: <a class="el" href="working_with_memory.html">Working with Memory and Performance</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<div class="ttc" id="aworkbook_8h_html_ad9e7aeebc0fd43562db5bcd527b2ee5e"><div class="ttname"><a href="workbook_8h.html#ad9e7aeebc0fd43562db5bcd527b2ee5e">workbook_close</a></div><div class="ttdeci">lxw_error workbook_close(lxw_workbook *workbook)</div><div class="ttdoc">Close the Workbook object and write the XLSX file.</div></div>
<div class="ttc" id="astructlxw__comment__options_html_a3a3399ada29d05d2e7702e881fbe3ccb"><div class="ttname"><a href="structlxw__comment__options.html#a3a3399ada29d05d2e7702e881fbe3ccb">lxw_comment_options::visible</a></div><div class="ttdeci">uint8_t visible</div><div class="ttdef"><b>Definition:</b> worksheet.h:1369</div></div>
<div class="ttc" id="astructlxw__comment__options_html"><div class="ttname"><a href="structlxw__comment__options.html">lxw_comment_options</a></div><div class="ttdoc">Options for inserted comments.</div><div class="ttdef"><b>Definition:</b> worksheet.h:1360</div></div>
<div class="ttc" id="aworkbook_8h_html_a1cf96608a23ee4eb0e8467c15240d00b"><div class="ttname"><a href="workbook_8h.html#a1cf96608a23ee4eb0e8467c15240d00b">workbook_new</a></div><div class="ttdeci">lxw_workbook * workbook_new(const char *filename)</div><div class="ttdoc">Create a new workbook object.</div></div>
<div class="ttc" id="astructlxw__comment__options_html_aa5cdcb6a45356c37c44c9601117e64a0"><div class="ttname"><a href="structlxw__comment__options.html#aa5cdcb6a45356c37c44c9601117e64a0">lxw_comment_options::y_scale</a></div><div class="ttdeci">double y_scale</div><div class="ttdef"><b>Definition:</b> worksheet.h:1394</div></div>
<div class="ttc" id="astructlxw__comment__options_html_ab536125829ddfea261406141685cd868"><div class="ttname"><a href="structlxw__comment__options.html#ab536125829ddfea261406141685cd868">lxw_comment_options::height</a></div><div class="ttdeci">uint16_t height</div><div class="ttdef"><b>Definition:</b> worksheet.h:1386</div></div>
<div class="ttc" id="astructlxw__comment__options_html_a85ea5b7a9deceb6b5dd9b1580b49b5a5"><div class="ttname"><a href="structlxw__comment__options.html#a85ea5b7a9deceb6b5dd9b1580b49b5a5">lxw_comment_options::x_offset</a></div><div class="ttdeci">int32_t x_offset</div><div class="ttdef"><b>Definition:</b> worksheet.h:1427</div></div>
<div class="ttc" id="astructlxw__worksheet_html"><div class="ttname"><a href="structlxw__worksheet.html">lxw_worksheet</a></div><div class="ttdoc">Struct to represent an Excel worksheet.</div><div class="ttdef"><b>Definition:</b> worksheet.h:1603</div></div>
<div class="ttc" id="astructlxw__comment__options_html_a6fe2a539fa5448c499fbbbef3215976c"><div class="ttname"><a href="structlxw__comment__options.html#a6fe2a539fa5448c499fbbbef3215976c">lxw_comment_options::x_scale</a></div><div class="ttdeci">double x_scale</div><div class="ttdef"><b>Definition:</b> worksheet.h:1390</div></div>
<div class="ttc" id="astructlxw__comment__options_html_a81608aa6e7816544847c1a74beb0f34d"><div class="ttname"><a href="structlxw__comment__options.html#a81608aa6e7816544847c1a74beb0f34d">lxw_comment_options::font_name</a></div><div class="ttdeci">char * font_name</div><div class="ttdef"><b>Definition:</b> worksheet.h:1403</div></div>
<div class="ttc" id="astructlxw__comment__options_html_ac5b73a7c784616e582aba3f3f7ae56d9"><div class="ttname"><a href="structlxw__comment__options.html#ac5b73a7c784616e582aba3f3f7ae56d9">lxw_comment_options::author</a></div><div class="ttdeci">char * author</div><div class="ttdef"><b>Definition:</b> worksheet.h:1376</div></div>
<div class="ttc" id="aworksheet_8h_html_aad352c6cf9a5359d4cda51839a91c7d2a3d78b49cb38d25b6d5473a1c0112404d"><div class="ttname"><a href="worksheet_8h.html#aad352c6cf9a5359d4cda51839a91c7d2a3d78b49cb38d25b6d5473a1c0112404d">LXW_COMMENT_DISPLAY_VISIBLE</a></div><div class="ttdeci">@ LXW_COMMENT_DISPLAY_VISIBLE</div><div class="ttdef"><b>Definition:</b> worksheet.h:218</div></div>
<div class="ttc" id="astructlxw__comment__options_html_a1360f4a255e8c255b3759d44205de938"><div class="ttname"><a href="structlxw__comment__options.html#a1360f4a255e8c255b3759d44205de938">lxw_comment_options::start_row</a></div><div class="ttdeci">lxw_row_t start_row</div><div class="ttdef"><b>Definition:</b> worksheet.h:1418</div></div>
<div class="ttc" id="aworksheet_8h_html_a158dadac385cd1007994e5478b7b2aa7"><div class="ttname"><a href="worksheet_8h.html#a158dadac385cd1007994e5478b7b2aa7">worksheet_write_comment_opt</a></div><div class="ttdeci">lxw_error worksheet_write_comment_opt(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *string, lxw_comment_options *options)</div><div class="ttdoc">Write a comment to a worksheet cell with options.</div></div>
<div class="ttc" id="aformat_8h_html_abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871"><div class="ttname"><a href="format_8h.html#abeafc6e8222ba9fcfd4f2c2f4e9ea38bae0b5c39ced3b8c871974f0e4917e4871">LXW_COLOR_GREEN</a></div><div class="ttdeci">@ LXW_COLOR_GREEN</div><div class="ttdef"><b>Definition:</b> format.h:196</div></div>
<div class="ttc" id="aworksheet_8h_html_af196b0cb611f3abc800f3439f3bb8942"><div class="ttname"><a href="worksheet_8h.html#af196b0cb611f3abc800f3439f3bb8942">worksheet_set_comments_author</a></div><div class="ttdeci">void worksheet_set_comments_author(lxw_worksheet *worksheet, const char *author)</div><div class="ttdoc">Set the default author of the cell comments.</div></div>
<div class="ttc" id="astructlxw__workbook_html"><div class="ttname"><a href="structlxw__workbook.html">lxw_workbook</a></div><div class="ttdoc">Struct to represent an Excel workbook.</div><div class="ttdef"><b>Definition:</b> workbook.h:273</div></div>
<div class="ttc" id="aworksheet_8h_html_ac208046e7a6d12cc87982422efa41b31"><div class="ttname"><a href="worksheet_8h.html#ac208046e7a6d12cc87982422efa41b31">worksheet_write_string</a></div><div class="ttdeci">lxw_error worksheet_write_string(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *string, lxw_format *format)</div><div class="ttdoc">Write a string to a worksheet cell.</div></div>
<div class="ttc" id="autility_8h_html_ad510ac6df573d23203374e24dba373d2"><div class="ttname"><a href="utility_8h.html#ad510ac6df573d23203374e24dba373d2">CELL</a></div><div class="ttdeci">#define CELL(cell)</div><div class="ttdoc">Convert an Excel A1 cell string into a (row, col) pair.</div><div class="ttdef"><b>Definition:</b> utility.h:45</div></div>
<div class="ttc" id="aworkbook_8h_html_a81d456b4f65a464e78e4a0030ecc3c2e"><div class="ttname"><a href="workbook_8h.html#a81d456b4f65a464e78e4a0030ecc3c2e">workbook_add_worksheet</a></div><div class="ttdeci">lxw_worksheet * workbook_add_worksheet(lxw_workbook *workbook, const char *sheetname)</div><div class="ttdoc">Add a new worksheet to a workbook.</div></div>
<div class="ttc" id="astructlxw__comment__options_html_abc75ab267fe81d828844e6a619c7edef"><div class="ttname"><a href="structlxw__comment__options.html#abc75ab267fe81d828844e6a619c7edef">lxw_comment_options::width</a></div><div class="ttdeci">uint16_t width</div><div class="ttdef"><b>Definition:</b> worksheet.h:1381</div></div>
<div class="ttc" id="astructlxw__image__options_html_ac75127b545dc66c6a24e3b41bd20a7ab"><div class="ttname"><a href="structlxw__image__options.html#ac75127b545dc66c6a24e3b41bd20a7ab">lxw_image_options::x_scale</a></div><div class="ttdeci">double x_scale</div><div class="ttdef"><b>Definition:</b> worksheet.h:1273</div></div>
<div class="ttc" id="aworksheet_8h_html_aad352c6cf9a5359d4cda51839a91c7d2a3d229e4bc94662b4ed744abd40182728"><div class="ttname"><a href="worksheet_8h.html#aad352c6cf9a5359d4cda51839a91c7d2a3d229e4bc94662b4ed744abd40182728">LXW_COMMENT_DISPLAY_HIDDEN</a></div><div class="ttdeci">@ LXW_COMMENT_DISPLAY_HIDDEN</div><div class="ttdef"><b>Definition:</b> worksheet.h:214</div></div>
<div class="ttc" id="aworksheet_8h_html_abd1728d105365c0113e15f40c6bb1b27"><div class="ttname"><a href="worksheet_8h.html#abd1728d105365c0113e15f40c6bb1b27">worksheet_write_comment</a></div><div class="ttdeci">lxw_error worksheet_write_comment(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *string)</div><div class="ttdoc">Write a comment to a worksheet cell.</div></div>
<!-- HTML footer for doxygen 1.8.20-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Copyright 2014-2020 John McNamara.
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
